# commentDemo.py
'''
这是一个示例模块，用于演示 Python 文档注释的用法。
该模块包含一个示例函数。
'''



def example_function():
    """
    这是一个示例函数，不接受任何参数，返回一个固定的字符串。
    """
    return "Hello, World!"



def add_numbers(a, b):
    """
    该函数用于计算两个数字的和。

    参数:
    a (int 或 float): 第一个数字。
    b (int 或 float): 第二个数字。

    返回:
    int 或 float: 两个数字的和。
    """
    return a + b

class Rectangle:
    """
    该类用于表示一个矩形，包含计算矩形面积和周长的方法。

    属性:
    length (float): 矩形的长度。
    width (float): 矩形的宽度。
    """
    def __init__(self, length, width):
        self.length = length
        self.width = width

    def area(self):
        """
        计算矩形的面积。

        返回:
        float: 矩形的面积。
        """
        return self.length * self.width

    def perimeter(self):
        """
        计算矩形的周长。

        返回:
        float: 矩形的周长。
        """
        return 2 * (self.length + self.width)



# 可以使用 Python 的内置属性 __doc__ 来访问对象的文档注释。

import commentDemo
print(commentDemo.__doc__)

# 访问函数的文档注释
print(add_numbers.__doc__)

# 访问类的文档注释
#
print(Rectangle.__doc__)
# 访问类方法的文档注释
print(Rectangle.area.__doc__)


